LINE Pay決済

LINE Pay決済 都度決済 API一覧

※idPass版にのみ対応しています。json版には対応しておりません。

HTTP仕様（.idPass）

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200：常に200を返却

EntryTranLinepay 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID
JobCd 必須
処理区分

AUTH：仮売上
CAPTURE：即時売上

Amount 必須 半角数字8桁
利用金額

Tax 半角数字7桁
税送料

税送料を指定した場合は、利用金額＋税送料が決済金額となります。

URL
/payment/EntryTranLinepay.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=AUTH&Amount=1000
レスポンス
正常
OrderID 必須 半角英数記号27桁
オーダーID
AccessID 必須 半角英数32桁 固定
取引ID
AccessPass 必須 半角英数32桁 固定
取引パスワード
異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
OrderID=ORDER0000001&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

ExecTranLinepay 決済実行

ユーザー端末情報がWEBの場合、これ以降の決済取引で必要となるトークンと遷移URLを返却します。
ユーザー端末情報がAPPの場合、これ以降の決済取引で必要となる遷移URLを返却します。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID
AccessPass 必須 半角英数32桁 固定
取引パスワード
OrderID 必須 半角英数記号27桁
オーダーID
ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

ClientFieldFlag 半角数字1桁
加盟店自由項目返却フラグ

以下のいずれかを設定します。
0：返却しない(デフォルト)
1：返却する

RetURL 必須 半角英数記号2048桁
決済結果戻しURL

加盟店様が当サービスからの決済結果を受信するための結果受信URLを設定します。

LINE Pay決済上でお客様が決済手続きを正常に完了された場合に、指定されたURLに結果をリダイレクト経由で送信されます。

ErrorRcvURL 必須 半角英数記号2048桁
処理NG時URL

加盟店様が当サービスからの処理失敗となった結果を受信するための処理NG時URLを設定します。

LINE Pay決済上でお客様が決済手続きを正常に完了できなかった場合に、指定されたURLに結果をリダイレクト経由で送信されます。

ProductName 必須 全半角4000桁
商品名
ProductImageUrl 半角英数記号500桁
商品画像URL

決済画面に表示する画像のURLを設定します。
サイズ：40 X 40

LangCd 半角英字10桁
言語コード

LINEPay決済待ち画面の言語コードを設定します。
ja：日本語
ko：韓国語
en：英語
zh-Hans：中国語(簡体字)
zh-Hant：中国語(繁体字)
th：タイ語
OSの設定、LINEPayアプリの設定により、言語が変わる可能性があるため、詳細はLINEPayにお問い合わせください。

UserInfo 半角数字1桁
ユーザー端末情報

1：WEB(デフォルト)
2：APP
※テスト環境においては「2：APP」はご利用いただけません。本項目を利用した動作確認については、ご契約後に本番環境にて実施をお願いします。
ReturnUrl 半角英数記号1000桁
戻り先URL

お客様の支払い完了後にLINE Payアプリから指定したURLに遷移します。カスタムURLスキームまたはユニバーサルリンクを指定してください。
端末情報には「2:APP」を指定してご利用ください。
※テスト環境において「戻り先URL」はご利用いただけません。本項目を利用した動作確認については、ご契約後に本番環境にて実施をお願いします。

BranchName 全半角100桁
店舗名

LINE Payアプリのお支払い履歴に100文字まで表示されます。
BranchID 半角英数記号32桁
店舗ID

決済がリクエストされた場所を識別するために利用します。

URL
/payment/ExecTranLinepay.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&RetURL=https://example.com/receive/success&ErrorRcvURL=https://example.com/receive/error&ProductName=sampleProduct
レスポンス
正常
Start 必須 半角数字1桁
Startフラグ

支払手続き開始IFのURL呼び出し要否を返却します。
1：必要あり

AccessID 必須 半角英数32桁 固定
取引ID

【決済実行】呼び出し時に指定した値を返却します。
【決済実行】呼び出し時に指定した端末情報が「WEB」の場合のみ返却されます。

Token 必須 半角英数記号256桁
トークン

取引IDのハッシュ値を返却します。
【決済実行】呼び出し時に指定した端末情報が「WEB」の場合のみ返却されます。

StartURL 必須 半角英数記号256桁
支払手続き開始IFのURL
異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
Start=1&AccessID=a6a6b0061347e90cdef806b39bd28705&Token=wpd8A+R8uWZt+GnF6auJtMZNSB4yzSCZR9xdztqdBjGwBS7yYvxSiC0zeMVH+O4F&StartURL=https://x01.xxxxx/payment/LinepayStart.idPass
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

LinepayStart 支払手続き開始IFの呼び出し

LINE Pay決済において、お客様をLINE Payの認証画面へと遷移させる必要があります。
加盟店様はリダイレクト機能を利用して、お客様を当サービスの支払手続き開始IFに誘導してください。
当サービスは各種パラメータを設定し、お客様をLINE Payの認証画面に誘導します。
※取引が特定できない場合、すでに支払いを済ませている場合、支払期限切れの場合等はエラー画面を表示します。

リクエスト
AccessID 必須 半角英数32桁 固定
取引ID
Token 必須 半角英数記号256桁 固定
トークン

【決済実行】で発行された値を設定します。

URL
/payment/LinepayStart.idPass
リクエストパラメータ
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=wpd8A+R8uWZt+GnF6auJtMZNSB4yzSCZR9xdztqdBjGwBS7yYvxSiC0zeMVH+O4F
リダイレクトページサンプル(ユーザー端末情報がWEBの場合)

<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
  </head>
  <body OnLoad='OnLoadEvent();'>
    <form name="LinepayStartCall" action="{LinepayStartURL}" method="POST">
    <noscript>
      <center>
        <h2>LINE Payの決済画面へ遷移します。</h2>
        <input type="submit" value="続行">
      </center>
      </noscript>
      <input type="hidden" name="AccessID" value="{AccessID}">
      <input type="hidden" name="Token" value="{Token}">
    </form>
    <script >
    <!--
      function OnLoadEvent() {
        document.LinepayStartCall.submit();
      }
    //-->
    </script>
  </body>
</html>
リダイレクトページサンプル(ユーザー端末情報がAPPの場合：Androidアプリの例)

下記のサンプルコードでLINEアプリのインストール有無と使用可能なLINE Payのバージョンを確認できます。
LINEアプリがインストールされていて、使用可能なLINE Payのバージョンが確認できたらLINE Pay決済画面へ移動します。


int linePaySupportedVersion = 230;
String paymentUrl = "{LinepayStartURL}"; // This is "StartUrl" String.
 
Context context = getActivity();
try {
    PackageManager pm = context.getPackageManager();
    PackageInfo packageInfo = pm.getPackageInfo("jp.naver.line.android", 0);
    int versionCode = packageInfo.versionCode;
    if (linePaySupportedVersion <= versionCode) {
        launchUri(paymentUrl);
    } else {
        confirmLineInstall(context);
    }
} catch (NameNotFoundException e) {
    confirmLineInstall(context);
}
 
private void confirmLineInstall(Context context) {
    new AlertDialog.Builder(context)
    .setTitle("LINE Pay")
    .setMessage(getString(R.String.linepay_confirm))
    .setCancelable(false)
    .setPositiveButton(getString(R.String.linepay_install), new
        DialogInterface.OnClickListener() {
            @Override
            public void onClick(DialogInterface dialog, int which) {
                launchUri("market://details?id=jp.naver.line.android");
            }
        })
    .setNegativeButton(getString(R.String.linepay_cancel), new
        DialogInterface.OnClickListener() {
            @Override
            public void onClick(DialogInterface dialog, int which) {
            }
        })
    .show();
}
 
private void launchUri(String uriString) {
    Uri uri = Uri.parse(uriString);
    Intent intent = new Intent(Intent.ACTION_VIEW, uri);
    startActivity(intent);
}
            

File : res/values/Strings.xml
<?xml version="1.0" encoding="utf-8"?>
<resources>
    ...
    <String name="linepay_confirm">Supported by Android/iPhone LINE versions 4.8.0 or higher.</String>
    <String name="linepay_install">Get it now</String>
    <String name="linepay_cancel">cancel</String>
    ...
</resources>
リダイレクトページサンプル(ユーザー端末情報がAPPの場合：iPhoneアプリの例)

下記のサンプルコードでLINEアプリのインストール有無を確認することができます。
LINEアプリがインストールされているとLINE Pay決済画面へ移動します。


NSString* lineScheme = @"line://";
BOOL installed = [[UIApplication sharedApplication]
                 canOpenURL:[NSURL URLWithString:lineScheme]];
if (installed) {
    UIAlertView *alert =
        [[UIAlertView alloc] initWithTitle:@"LINE Pay"
            message:NSLocalizedString(@"linepay.confirm", nil)
            delegate:self
            cancelButtonTitle:NSLocalizedString(@"linepay.ok", nil)
            otherButtonTitles:nil];
    alert.tag = 1;
    [alert show];
} else {
    UIAlertView *alert =
        [[UIAlertView alloc] initWithTitle:@"LINE Pay"
            message:NSLocalizedString(@"linepay.confirm", nil)
            delegate:self
            cancelButtonTitle:NSLocalizedString(@"linepay.cancel", nil)
            otherButtonTitles:NSLocalizedString(@"linepay.install", nil), nil];
    alert.tag = 2;
    [alert show];
}
- (void)alertView:(UIAlertView*)alertView clickedButtonAtIndex:(NSInteger)buttonIndex {
    if (alertView.tag == 1 && buttonIndex == 0) {
        NSString *paymentUrl = "{LinepayStartURL}"; // This is "StartUrl" String.
        [self launchUrl:paymentUrl];
    } else if (alertView.tag == 2 && buttonIndex == 1) {
        [self launchUrl:@"itmsapps://
        itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=443904275&mt=8"];
    }
}
- (void)launchUrl:(NSString*)urlString {
    NSURL *url = [NSURL URLWithString:urlString];
    [[UIApplication sharedApplication] openURL:url];
}

リダイレクト後、お客様はLINE Payログイン画面へ遷移します。

決済結果受信

当サービスは支払操作が完了している場合は、【決済実行】で指定した決済結果戻しURLに決済結果を通知します。
支払操作がキャンセルされた場合、及び支払い操作が失敗した場合は、【決済実行】で指定した処理NG時URLに結果を通知します。
ブラウザを×ボタンで閉じた場合など、ユーザの操作方法によっては支払操作が完了したにもかかわらず、加盟店様に通知されないことがあります。
その際はショップ管理画面または結果通知にてご確認ください。
また、同様の理由でこの決済結果が複数回加盟店様に通知されることがあります。

レスポンス
正常
ShopID 必須 半角英数13桁
ショップID
OrderID 必須 半角英数記号27桁
オーダーID
AccessID 必須 半角英数32桁 固定
取引ID
Status 必須
現状態

該当取引の取引状態を返却します。
処理成功時
・AUTH
・CAPTURE
処理失敗時
・PAYFAIL
・PAYCANCEL
CheckString 必須 半角英数記号32桁
MD5ハッシュ

OrderID,AccessID,ShopID,ShopPassのハッシュ値を返却します。
PayMethod 必須 半角英字記号20桁
支払手段

LINEPayで決済時に使用した決済手段が返却されます。
クレジットカード：CREDIT_CARD
残高：BALANCE

ClientField1 全半角100バイト
加盟店自由項目1
ClientField2 全半角100バイト
加盟店自由項目2
ClientField3 全半角100バイト
加盟店自由項目3
異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
ShopID=tshop11223344&OrderID=ORDER0000001&AccessID=467d50a6bc03dabe1713f8d49042bd96&Status=AUTH&CheckString=eca915699bfaf2afa4284988d67d7fac&PayMethod=CREDIT_CARD&ClientField1=&ClientField2=&ClientField3=
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

LinepayCancelReturn キャンセル・返品

決済が完了した取引に対して決済内容のキャンセル・返品を行います。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID
AccessPass 必須 半角英数32桁 固定
取引パスワード
CancelAmount 必須 半角数字8桁
キャンセル金額
CancelTax 半角数字7桁
キャンセル税送料

キャンセル金額＋キャンセル税送料をキャンセル金額とします。（1円以上）
仮売上をキャンセルする場合、キャンセル金額とキャンセル税送料はオーソリ時の金額を指定してください。
即時売上、実売上を返品する場合、売上確定金額の一部返品が可能です。
例）仮売上525円よりキャンセル→キャンセル金額：525円
実売上525円より210円分返品→キャンセル金額：210円

URL
/payment/LinepayCancelReturn.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&CancelAmount=500
レスポンス
正常
OrderID 必須 半角英数記号27桁
オーダーID

AccessID 必須 半角英数32桁 固定
取引ID

【決済キャンセル・返品】呼び出し時に指定した値を返却します。

Status 必須
現状態

キャンセル・返品成功時は以下のステータスが返却されます。
・CANCEL：キャンセル
・RETURN：返品

キャンセル・返品失敗時、または一部返品時はキャンセル・返品処理前のステータスが返却されます。

Amount 必須 半角数字8桁
利用金額

利用金額からキャンセル金額を減算した結果を返却します。

例）利用金額5,000円よりキャンセル金額3,000円→利用金額：2,000円

Tax 必須 半角数字7桁
税送料

税送料からキャンセル税送料を減算した結果を返却します。

例）税送料250円よりキャンセル税送料150円→税送料：100円

CancelAmount 必須 半角数字8桁
キャンセル金額

CancelTax 必須 半角数字7桁
キャンセル税送料

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
OrderID=ORDER0000001&AccessID=a6a6b0061347e90cdef806b39bd28705&Status=CANCEL&Amount=0&Tax=0&CancelAmount=1000&CancelTax=100
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

LinepaySales 実売上

仮売上の決済に対して実売上を行います。尚、実行時に仮売上時との金額チェックを行います。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID
AccessPass 必須 半角英数32桁 固定
取引パスワード
Amount 必須 半角数字8桁
利用金額

Tax 半角数字7桁
税送料

利用金額＋税送料が売上金額となります（1円以上）
※0円の場合はエラーとします。
※オーソリ時より大きい金額の場合はエラーとします。
※オーソリ時と異なる金額の場合は、指定された金額で売上を確定します。

URL
/payment/LinepaySales.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=1000
レスポンス
正常
OrderID 必須 半角英数記号27桁
オーダーID
AccessID 必須 半角英数32桁 固定
取引ID

【実売上】呼び出し時に指定した値を返却します。

Status 必須
現状態

売上確定成功時は以下のステータスが返却されます。
・SALES：実売上
売上確定失敗時は売上確定処理前のステータスが返却されます。

Amount 必須 半角数字8桁
利用金額

Tax 必須 半角数字7桁
税送料

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
OrderID=ORDER0000001&AccessID=a6a6b0061347e90cdef806b39bd28705&Status=SALES&Amount=1000&Tax=100
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。 ※idPass版にのみ対応しています。json版には対応していません。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID

PayType 必須 半角数字2桁
決済方法

20：LINE Pay決済

URL
/payment/SearchTradeMulti.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=20
レスポンス
正常
Status 必須
現状態

UNPROCESSED：未決済
REQSUCCESS：要求成功
PAYSTART：決済開始
PAYCANCEL：決済中止
PAYFAIL：決済失敗
AUTH：仮売上
SALES：実売上
CAPTURE：即時売上
CANCEL：キャンセル
RETURN：返品
EXPIRED：期限切れ

ProcessDate 必須 半角数字14桁 固定
処理日時

yyyyMMddHHmmss書式

JobCd 必須
処理区分

AUTH：仮売上
SALES：実売上
CAPTURE：即時売上
CANCEL：キャンセル
RETURN：返品

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

Amount 必須 半角数字8桁
利用金額

Tax 必須 半角数字13桁
税送料

SiteID 半角英数13桁
サイトID

未使用項目

MemberID 半角英数60桁
会員ID

未使用項目

Currency 必須 半角英字3桁
通貨コード

TranID 半角英数19桁
LINE PayトランザクションID

ClientField1 必須 全半角100バイト
加盟店自由項目1

ClientField2 必須 全半角100バイト
加盟店自由項目2

ClientField3 必須 全半角100バイト
加盟店自由項目3

PayType 必須 半角数字2桁
決済方法

20：LINE Pay

LinepayProductName 全半角4000桁
LINE Pay商品名

LinepayPayMethod 半角英数20桁
支払方法

決済に使用されたLINE Pay決済の支払手段を返却します。

LinepayCancelAmount 半角数字8桁
キャンセル金額
LinepayCancelTax 半角数字8桁
キャンセル税送料
異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
Status=SALES&ProcessDate=20210308125035&JobCd=SALES&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=1000&Tax=100&SiteID=&MemberID=&Currency=JPY&TranID=STUB469727263704766&ClientField1=&ClientField2=&ClientField3=&PayType=20&LinepayProductName=test&LinepayPayMethod=CREDIT_CARD&LinepayCancelAmount=0&LinepayCancelTax=0
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001